<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>gpio: XGpio Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">gpio
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_gpio.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XGpio Struct Reference<div class="ingroups"><a class="el" href="group__gpio__api.html">GPIO APIs</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_gpio.html" title="The XGpio driver instance data. ">XGpio</a> driver instance data.  
 <a href="struct_x_gpio.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad4f1e3dea77b3d89d4c67b61516eabfe"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_gpio.html#ad4f1e3dea77b3d89d4c67b61516eabfe">BaseAddress</a></td></tr>
<tr class="memdesc:ad4f1e3dea77b3d89d4c67b61516eabfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device base address.  <a href="#ad4f1e3dea77b3d89d4c67b61516eabfe">More...</a><br/></td></tr>
<tr class="separator:ad4f1e3dea77b3d89d4c67b61516eabfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3652328c3d29797110949baaaff300fc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_gpio.html#a3652328c3d29797110949baaaff300fc">IsReady</a></td></tr>
<tr class="memdesc:a3652328c3d29797110949baaaff300fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is initialized and ready.  <a href="#a3652328c3d29797110949baaaff300fc">More...</a><br/></td></tr>
<tr class="separator:a3652328c3d29797110949baaaff300fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd2357402ecaeff664407202ce6d9a81"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_gpio.html#acd2357402ecaeff664407202ce6d9a81">InterruptPresent</a></td></tr>
<tr class="memdesc:acd2357402ecaeff664407202ce6d9a81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Are interrupts supported in h/w.  <a href="#acd2357402ecaeff664407202ce6d9a81">More...</a><br/></td></tr>
<tr class="separator:acd2357402ecaeff664407202ce6d9a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af688ddb928355a5f70748b97ec4aa593"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_gpio.html#af688ddb928355a5f70748b97ec4aa593">IsDual</a></td></tr>
<tr class="memdesc:af688ddb928355a5f70748b97ec4aa593"><td class="mdescLeft">&#160;</td><td class="mdescRight">Are 2 channels supported in h/w.  <a href="#af688ddb928355a5f70748b97ec4aa593">More...</a><br/></td></tr>
<tr class="separator:af688ddb928355a5f70748b97ec4aa593"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_gpio.html" title="The XGpio driver instance data. ">XGpio</a> driver instance data. </p>
<p>The user is required to allocate a variable of this type for every GPIO device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ad4f1e3dea77b3d89d4c67b61516eabfe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XGpio::BaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device base address. </p>

<p>Referenced by <a class="el" href="group__gpio__api.html#gaf76e70c9ddd0dc3966123c09646d880c">XGpio_CfgInitialize()</a>, <a class="el" href="group__gpio__api.html#gae430718af9f347c91be42aad580b216c">XGpio_DiscreteClear()</a>, <a class="el" href="group__gpio__api.html#gaed95c58f21d567fca624f9f51cb25e20">XGpio_DiscreteRead()</a>, <a class="el" href="group__gpio__api.html#ga8f2cea7ef78412c03c7ebdba87b7cdd4">XGpio_DiscreteSet()</a>, <a class="el" href="group__gpio__api.html#gae188a28725318c991ac45afb2452ad9b">XGpio_DiscreteWrite()</a>, <a class="el" href="group__gpio__api.html#ga77090853c15dc3d72e2bfbc66e635ada">XGpio_GetDataDirection()</a>, <a class="el" href="group__gpio__api.html#ga5138b55159f8b2387f5cf16079b40bbe">XGpio_InterruptClear()</a>, <a class="el" href="group__gpio__api.html#ga21c295f935fdc4e37c9f958b3652fbf6">XGpio_InterruptDisable()</a>, <a class="el" href="group__gpio__api.html#gaa5b62394f65ecbb6566d91412616509c">XGpio_InterruptEnable()</a>, <a class="el" href="group__gpio__api.html#ga1e5e23001aa3d35febe4859270ede71e">XGpio_InterruptGetEnabled()</a>, <a class="el" href="group__gpio__api.html#ga95b0fa50ff962243ea284a4a767fe01e">XGpio_InterruptGetStatus()</a>, <a class="el" href="group__gpio__api.html#ga6241d0ae28815c258bb89a61ce0a6366">XGpio_InterruptGlobalDisable()</a>, <a class="el" href="group__gpio__api.html#ga116bf1509220aa688f76f80501eb0d9e">XGpio_InterruptGlobalEnable()</a>, and <a class="el" href="group__gpio__api.html#gabee6bcad28382ef5ecd336887647c238">XGpio_SetDataDirection()</a>.</p>

</div>
</div>
<a class="anchor" id="acd2357402ecaeff664407202ce6d9a81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XGpio::InterruptPresent</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Are interrupts supported in h/w. </p>

<p>Referenced by <a class="el" href="group__gpio__api.html#gaf76e70c9ddd0dc3966123c09646d880c">XGpio_CfgInitialize()</a>, <a class="el" href="group__gpio__api.html#ga5138b55159f8b2387f5cf16079b40bbe">XGpio_InterruptClear()</a>, <a class="el" href="group__gpio__api.html#ga21c295f935fdc4e37c9f958b3652fbf6">XGpio_InterruptDisable()</a>, <a class="el" href="group__gpio__api.html#gaa5b62394f65ecbb6566d91412616509c">XGpio_InterruptEnable()</a>, <a class="el" href="group__gpio__api.html#ga1e5e23001aa3d35febe4859270ede71e">XGpio_InterruptGetEnabled()</a>, <a class="el" href="group__gpio__api.html#ga95b0fa50ff962243ea284a4a767fe01e">XGpio_InterruptGetStatus()</a>, <a class="el" href="group__gpio__api.html#ga6241d0ae28815c258bb89a61ce0a6366">XGpio_InterruptGlobalDisable()</a>, and <a class="el" href="group__gpio__api.html#ga116bf1509220aa688f76f80501eb0d9e">XGpio_InterruptGlobalEnable()</a>.</p>

</div>
</div>
<a class="anchor" id="af688ddb928355a5f70748b97ec4aa593"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XGpio::IsDual</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Are 2 channels supported in h/w. </p>

<p>Referenced by <a class="el" href="group__gpio__api.html#gaf76e70c9ddd0dc3966123c09646d880c">XGpio_CfgInitialize()</a>, <a class="el" href="group__gpio__api.html#gae430718af9f347c91be42aad580b216c">XGpio_DiscreteClear()</a>, <a class="el" href="group__gpio__api.html#gaed95c58f21d567fca624f9f51cb25e20">XGpio_DiscreteRead()</a>, <a class="el" href="group__gpio__api.html#ga8f2cea7ef78412c03c7ebdba87b7cdd4">XGpio_DiscreteSet()</a>, <a class="el" href="group__gpio__api.html#gae188a28725318c991ac45afb2452ad9b">XGpio_DiscreteWrite()</a>, <a class="el" href="group__gpio__api.html#ga77090853c15dc3d72e2bfbc66e635ada">XGpio_GetDataDirection()</a>, and <a class="el" href="group__gpio__api.html#gabee6bcad28382ef5ecd336887647c238">XGpio_SetDataDirection()</a>.</p>

</div>
</div>
<a class="anchor" id="a3652328c3d29797110949baaaff300fc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XGpio::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p>Referenced by <a class="el" href="group__gpio__api.html#gaf76e70c9ddd0dc3966123c09646d880c">XGpio_CfgInitialize()</a>, <a class="el" href="group__gpio__api.html#gae430718af9f347c91be42aad580b216c">XGpio_DiscreteClear()</a>, <a class="el" href="group__gpio__api.html#gaed95c58f21d567fca624f9f51cb25e20">XGpio_DiscreteRead()</a>, <a class="el" href="group__gpio__api.html#ga8f2cea7ef78412c03c7ebdba87b7cdd4">XGpio_DiscreteSet()</a>, <a class="el" href="group__gpio__api.html#gae188a28725318c991ac45afb2452ad9b">XGpio_DiscreteWrite()</a>, <a class="el" href="group__gpio__api.html#ga77090853c15dc3d72e2bfbc66e635ada">XGpio_GetDataDirection()</a>, <a class="el" href="group__gpio__api.html#ga080482882d1f60cbd84b8e4ea856560c">XGpio_Initialize()</a>, <a class="el" href="group__gpio__api.html#ga5138b55159f8b2387f5cf16079b40bbe">XGpio_InterruptClear()</a>, <a class="el" href="group__gpio__api.html#ga21c295f935fdc4e37c9f958b3652fbf6">XGpio_InterruptDisable()</a>, <a class="el" href="group__gpio__api.html#gaa5b62394f65ecbb6566d91412616509c">XGpio_InterruptEnable()</a>, <a class="el" href="group__gpio__api.html#ga1e5e23001aa3d35febe4859270ede71e">XGpio_InterruptGetEnabled()</a>, <a class="el" href="group__gpio__api.html#ga95b0fa50ff962243ea284a4a767fe01e">XGpio_InterruptGetStatus()</a>, <a class="el" href="group__gpio__api.html#ga6241d0ae28815c258bb89a61ce0a6366">XGpio_InterruptGlobalDisable()</a>, <a class="el" href="group__gpio__api.html#ga116bf1509220aa688f76f80501eb0d9e">XGpio_InterruptGlobalEnable()</a>, <a class="el" href="group__gpio__api.html#gaf01e2f4d8e75fa4922a5d92798be7b25">XGpio_SelfTest()</a>, and <a class="el" href="group__gpio__api.html#gabee6bcad28382ef5ecd336887647c238">XGpio_SetDataDirection()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
